<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>v_hcresampler: V_hcresampler_v1_0</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_hcresampler
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a>  </div>
  <div class="headertitle">
<div class="title">V_hcresampler_v1_0</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v__hcresampler__l2.html">XV_hcresampler_l2</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Hw Configuration</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpe07496529b2051c7e9395499f7cf4d41"></a>The following constants define the horiz.</p>
<p>resampler HW MAX configuration </p>
</td></tr>
<tr class="memitem:ga25883ffa337f8e4cc3dda6b6e4fce5ce"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#ga25883ffa337f8e4cc3dda6b6e4fce5ce">XV_HCRESAMPLER_TYPE</a> <tr class="separator:ga25883ffa337f8e4cc3dda6b6e4fce5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
<tr class="memitem:gaef720bd6ce0338710642793498568a65"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#gaef720bd6ce0338710642793498568a65">XV_HCrsmplStart</a> (<a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *InstancePtr)</td></tr>
<tr class="separator:gaef720bd6ce0338710642793498568a65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga265ffe37fa1430db3f5acbac80eecfb6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#ga265ffe37fa1430db3f5acbac80eecfb6">XV_HCrsmplStop</a> (<a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *InstancePtr)</td></tr>
<tr class="separator:ga265ffe37fa1430db3f5acbac80eecfb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05f213f6570ae6970989cfcfddc52744"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#ga05f213f6570ae6970989cfcfddc52744">XV_HCrsmplLoadDefaultCoeff</a> (<a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *InstancePtr, <a class="el" href="struct_x_v__hcresampler__l2.html">XV_hcresampler_l2</a> *pHcrsmplL2Data)</td></tr>
<tr class="separator:ga05f213f6570ae6970989cfcfddc52744"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3ecd6c45855c8bbac2a84d2dcc0b2252"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#ga3ecd6c45855c8bbac2a84d2dcc0b2252">XV_HCrsmplrLoadExtCoeff</a> (<a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *InstancePtr, <a class="el" href="struct_x_v__hcresampler__l2.html">XV_hcresampler_l2</a> *pHcrsmplL2Data, u16 num_taps, const short *Coeff)</td></tr>
<tr class="separator:ga3ecd6c45855c8bbac2a84d2dcc0b2252"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9188fd1e2a71d1d1f56a0caa4c03c2fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#ga9188fd1e2a71d1d1f56a0caa4c03c2fc">XV_HCrsmplSetActiveSize</a> (<a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *InstancePtr, u32 width, u32 height)</td></tr>
<tr class="separator:ga9188fd1e2a71d1d1f56a0caa4c03c2fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22bd4075858bf9aa2ea376d51c13da59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#ga22bd4075858bf9aa2ea376d51c13da59">XV_HCrsmplSetFormat</a> (<a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *InstancePtr, <a class="el" href="struct_x_v__hcresampler__l2.html">XV_hcresampler_l2</a> *pHcrsmplL2Data, XVidC_ColorFormat formatIn, XVidC_ColorFormat formatOut)</td></tr>
<tr class="separator:ga22bd4075858bf9aa2ea376d51c13da59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d331490ab699e0bd813414610e5d862"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hcresampler__v1__0.html#ga0d331490ab699e0bd813414610e5d862">XV_HCrsmplDbgReportStatus</a> (<a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *InstancePtr)</td></tr>
<tr class="separator:ga0d331490ab699e0bd813414610e5d862"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaa674edda56028d2861403fc370971c62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__hcresampler__v1__0.html#gaa674edda56028d2861403fc370971c62">XV_HCRESAMPLER_CONVERSION</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8h.html">xv_hcresampler_l2.h</a>&gt;</code></p>

<p>This typedef enumerates the conversion type. </p>

</div>
</div>
<a class="anchor" id="gadb052c33e35fe9958149503a3a81c3ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__hcresampler__v1__0.html#gadb052c33e35fe9958149503a3a81c3ee">XV_HCRESAMPLER_TAPS</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8h.html">xv_hcresampler_l2.h</a>&gt;</code></p>

<p>This typedef enumerates the supported taps. </p>

</div>
</div>
<a class="anchor" id="ga25883ffa337f8e4cc3dda6b6e4fce5ce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__hcresampler__v1__0.html#ga25883ffa337f8e4cc3dda6b6e4fce5ce">XV_HCRESAMPLER_TYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8h.html">xv_hcresampler_l2.h</a>&gt;</code></p>

<p>This typedef enumerates the resampling algorithm. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0d331490ab699e0bd813414610e5d862"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HCrsmplDbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8c.html">xv_hcresampler_l2.c</a>&gt;</code></p>

<p>This function prints Chroma Resampler status on the console. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hcresampler___config.html#ae58868df8798e7915f0272ec3304a510">XV_hcresampler_Config::BaseAddress</a>, <a class="el" href="struct_x_v__hcresampler.html#a9339e0f851abaeb3d71a74082229b51a">XV_hcresampler::Config</a>, <a class="el" href="struct_x_v__hcresampler___config.html#a87d8f42750fbc34b7cbd1195acc5402a">XV_hcresampler_Config::NumTaps</a>, and <a class="el" href="struct_x_v__hcresampler___config.html#a42453638babe61766681305da466ea17">XV_hcresampler_Config::ResamplingType</a>.</p>

</div>
</div>
<a class="anchor" id="ga05f213f6570ae6970989cfcfddc52744"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HCrsmplLoadDefaultCoeff </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler__l2.html">XV_hcresampler_l2</a> *&#160;</td>
          <td class="paramname"><em>pHcrsmplL2Data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8c.html">xv_hcresampler_l2.c</a>&gt;</code></p>

<p>This function loads default filter coefficients in the chroma resampler coefficient storage based on the selected TAP configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">pHcrsmplL2Data</td><td>is a pointer to the core instance layer 2 data.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hcresampler.html#a9339e0f851abaeb3d71a74082229b51a">XV_hcresampler::Config</a>, <a class="el" href="struct_x_v__hcresampler___config.html#a87d8f42750fbc34b7cbd1195acc5402a">XV_hcresampler_Config::NumTaps</a>, and <a class="el" href="group__v__hcresampler__v1__0.html#ga3ecd6c45855c8bbac2a84d2dcc0b2252">XV_HCrsmplrLoadExtCoeff()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3ecd6c45855c8bbac2a84d2dcc0b2252"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HCrsmplrLoadExtCoeff </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler__l2.html">XV_hcresampler_l2</a> *&#160;</td>
          <td class="paramname"><em>pHcrsmplL2Data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_taps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const short *&#160;</td>
          <td class="paramname"><em>Coeff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8c.html">xv_hcresampler_l2.c</a>&gt;</code></p>

<p>This function loads user defined filter coefficients in the horiz. </p>
<p>chroma resampler coefficient storage</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">pHcrsmplL2Data</td><td>is a pointer to the core instance layer 2 data. </td></tr>
    <tr><td class="paramname">num_taps</td><td>is the number of taps </td></tr>
    <tr><td class="paramname">Coeff</td><td>is a pointer to user defined filter coefficients table</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hcresampler.html#a9339e0f851abaeb3d71a74082229b51a">XV_hcresampler::Config</a>, and <a class="el" href="struct_x_v__hcresampler___config.html#a87d8f42750fbc34b7cbd1195acc5402a">XV_hcresampler_Config::NumTaps</a>.</p>

<p>Referenced by <a class="el" href="group__v__hcresampler__v1__0.html#ga05f213f6570ae6970989cfcfddc52744">XV_HCrsmplLoadDefaultCoeff()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9188fd1e2a71d1d1f56a0caa4c03c2fc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HCrsmplSetActiveSize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>height</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8c.html">xv_hcresampler_l2.c</a>&gt;</code></p>

<p>This function configures the Chroma resampler active resolution. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">width</td><td>is the active frame width </td></tr>
    <tr><td class="paramname">height</td><td>is the active frame height</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="ga22bd4075858bf9aa2ea376d51c13da59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HCrsmplSetFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler__l2.html">XV_hcresampler_l2</a> *&#160;</td>
          <td class="paramname"><em>pHcrsmplL2Data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>formatIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>formatOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8c.html">xv_hcresampler_l2.c</a>&gt;</code></p>

<p>This function configures the Chroma resampler for the required format conversion. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">pHcrsmplL2Data</td><td>is a pointer to the core instance layer 2 data. </td></tr>
    <tr><td class="paramname">formatIn</td><td>is the input chroma format </td></tr>
    <tr><td class="paramname">formatOut</td><td>is required chroma format</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hcresampler.html#a9339e0f851abaeb3d71a74082229b51a">XV_hcresampler::Config</a>, and <a class="el" href="struct_x_v__hcresampler___config.html#a42453638babe61766681305da466ea17">XV_hcresampler_Config::ResamplingType</a>.</p>

</div>
</div>
<a class="anchor" id="gaef720bd6ce0338710642793498568a65"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HCrsmplStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8c.html">xv_hcresampler_l2.c</a>&gt;</code></p>

<p>This function starts the Chroma resampler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="ga265ffe37fa1430db3f5acbac80eecfb6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HCrsmplStop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hcresampler.html">XV_hcresampler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hcresampler__l2_8c.html">xv_hcresampler_l2.c</a>&gt;</code></p>

<p>This function stops the Chroma resampler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
